home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / call201a.zip / CALLER.DOC next >
Text File  |  1990-02-28  |  7KB  |  156 lines
  1. ┌──────────────────────────────────────────────────────────────────────────────┐
  2. │ CALLED-WHEN v2.01a                       Oliver Bell (GTPN Net/Node 050/030) │
  3. └──────────────────────────────────────────────────────────────────────────────┘
  4.  
  5. Lets start this by saying that I like to keep DOCS to anything as short and
  6. sweet as possible (I used to hate writing essays at school as well!).
  7.  
  8. Caller is a part of the ClogNet Utility Suite, a suite of companion utilities
  9. coming from Lancashire in the north of England.
  10.  
  11.  
  12. Setting Up CALLED-WHEN? to work on your system
  13. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14. OK here goes, Caller was originally written to run as an offline program
  15. for my own interest - so that I could see how many people called from
  16. a certain area and how many of those were registered or un-registered etc.
  17. It has since been modified to be run as a door. I have run it without problems
  18. under both CTTY and GATEWAY with the following batch file.
  19.  
  20. echo off
  21. chektime on
  22. %1 COM%2
  23. caller
  24. Pause
  25. %1 CON
  26. chektime off
  27.  
  28.  
  29. The only other thing involved with setup is to create a file in the GTPATH
  30. called CALLER.BBS.
  31.  
  32. N.B. the file does not have to be called CALLER.BBS this is only a default
  33. setting. by using the command line parameter 'file:????????.???' you can
  34. redefine the filename to whatever you want. (see command line
  35. parameters below)
  36.  
  37. The contents of the caller bbs file could be as follows:-
  38.  
  39. Sysop=0
  40. Co-Sysop=1
  41. GT Sysop=6789A
  42. Registered=ab
  43. Unregistered=z
  44. NonSysop=Dave Churm
  45.  
  46. To take the first line as an example, the word "Registered" is the status
  47. of all users with access levels 'a' and 'b'.
  48.  
  49. Therefore if Mark Shasby from Rossendale Lancashire was a registered user
  50. on my board at access level '6', and Lisa Johnson also from Rossendale
  51. in Lancashire was a registered user on my board at level 'b', and then if
  52. a user did a search for all users from rossendale the following would
  53. be displayed.
  54.  
  55. -------------------------------------------------------------------------------
  56.  User Name       Calling From              Last On   At     Calls Status
  57. -------------------------------------------------------------------------------
  58.  Mark Shasby     Rossendale, Lancashire    02-02-90  23:43     94 GT Sysop
  59.  Lisa Johnson    Rossendale, Lancs         18-02-90  10:44     10 Registered
  60.  Dougy Spencer   Rossendale, Lancashire    24-02-90   1:59      1 Unregistered
  61. -------------------------------------------------------------------------------
  62.  
  63. And yup - you guessed it I also have a user on my board from
  64. Rossendale in Lancashire called Dougy Spencer who is at access level 'z'.
  65.  
  66. You will now be asking - well what about the line that says 'NonSysop=....'
  67. well this also has a practical use in life - if the 'boardname' parameter
  68. is set (see command line parameters below) and one of the callers in your
  69. USER.CTL  file is not a sysop, although shares his name with someone in the
  70. nodelist, you would put their name in there so that the boardname parameter
  71. had no effect on that person.
  72.  
  73. e.g. If you had a caller on your board called 'Mark Shasby', and it's not
  74. the real one, then you would have a line in your CALLER.BBS file that read:-
  75.  
  76. NonSysop=Mark Shasby
  77.  
  78. N.B. All users at access levels not mentioned in the CALLER.BBS file
  79. will not be shown when the CALLER program is run.
  80.  
  81. After this has been done setup is complete. All you have to do now is to
  82. type "CALLER" from the DOS prompt to run the program.
  83.  
  84. If you have any further problems please either Netmail me OR call my board
  85. directly.
  86.  
  87.  
  88. Command Line Parameters
  89. ~~~~~~~~~~~~~~~~~~~~~~~
  90. There are a number of words that you can add to the command line to enhance
  91. the way that CALLED-WHEN? works and to tailor it to your own wants. They
  92. are as follows:-
  93.  
  94. ANSI      --  To force ANSI colour, this would not be used in normal operation
  95.               and was put there for use in local modes only.
  96.  
  97. AUTHOR    --  This is present for those who really don't appriciate freeware,
  98.               it will suppress the line with the name and phone number of my
  99.               board at the bottom of the report.
  100.  
  101. BOARDNAME --  This will make a slight alteration to the report - the
  102.               program will check the names in the user file against the the
  103.               nodelist and if a sysop is found the location field will be
  104.               changed to the name of his BBS.
  105.  
  106. FILE:     --  This parameter would be used if for some reason you wished to
  107.               use a filename other than 'CALLER.BBS' as the name of the
  108.               configuration file. e.g. to use a file called LASTON.BBS you
  109.               would use the command line 'CALLER FILE:LASTON.BBS' (without
  110.               the quotes).
  111.  
  112. LOOP      --  If the LOOP parameter is present then when the search is
  113.               finished the user will be presented with the question 'Do you
  114.               wish to search for another user?' instead of just exiting from
  115.               the program and returning to the board.
  116.  
  117. NOANSI    --  To force ANSI colour off, this does the oposite of the above,
  118.               although is there to be used in similar circumstances by people
  119.               using mono monitors.
  120.  
  121. NOPAUSE   --  Suppressed the 'more?' prompt and allows the screen to scroll
  122.               freely.
  123.  
  124. QUIT      --  At the early stages of the program when the user is entering the
  125.               details of the information that he wishes to search for if the
  126.               enter key is pressed and the field is empty the program will
  127.               terminate with this option set the program will ask the user
  128.               if he wishes to return to the board or not.
  129.  
  130. REGISTER  --  This is a simple command line parameter that is used if you wish
  131.               to register the Called-When? program - registration costs nothing
  132.               and the only reason for its existance is so that I know who is
  133.               running the program and whether or not it's worth while carrying
  134.               on development.
  135.  
  136. TOTAL     --  Using this a couple of extra lines will be added at the bottom
  137.               of the report informing you of the total number of users that
  138.               have been found.
  139.  
  140. Those amongst you that ran version 1.xx of caller outside the US will
  141. notice that the 'UK' parameter no longer exists, CALLED-WHEN? will now work
  142. out for itself which country it is running in.
  143.  
  144. Revision History
  145. ~~~~~~~~~~~~~~~~
  146. Version 2.00e  --  Initial release of version 2.00.
  147. (21.02.90)
  148.  
  149. Version 2.01a  --  Addition of REGISTER parameter.
  150.                    Addition of 'Calls' column to report.
  151.                    Many Thanks to Mike Heggen & Mike Robinson.
  152.  
  153. ┌──────────────────────────────────────────────────────────────────────────────┐
  154. │ "ABOVE BOARD" bbs  --  +44 (0)254 682862  --  v.21, v.22, v.22BIS, 9600:HST  │
  155. └──────────────────────────────────────────────────────────────────────────────┘
  156.